GET PlanCare2Api/Clients?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Gets a list of clients by their unique identifiers

Request Information

URI Parameters

Name	Description	Type	Additional information
clientIds	Identifiers of clients	Collection of integer	Required

Body Parameters

None.

Response Information

Resource Description

Clients

Collection of Client

Name	Description	Type	Additional information
RelationId	Id of relation	integer	-
SocialSecurityNumber	SocialSecurityNumber	string	-
SocialSecurityNumberVerified	SocialSecurityNumberVerified	boolean	-
SocialSecurityNumberVerificationInfo	SocialSecurityNumberVerificationInfo	string	-
FirstName	FirstName	string	-
Initials	Initials	string	-
NickName	NickName	string	-
BirthName	BirthName	string	-
BirthNamePrefix	BirthNamePrefix	string	-
PartnerName	PartnerName	string	-
PartnerNamePrefix	PartnerNamePrefix	string	-
LookupName	LookupName	string	-
LastName	LastName	string	-
Gender	Gender	string	-
DateOfBirth	DateOfBirth	date	Nullable
DateOfBirthCompleteness	The precision of the date of birth	DateCompleteness	-
CityOfBirth	CityOfBirth	string	-
CountryOfBirthId	CountryOfBirthId	integer	Nullable
DateOfDeath	DateOfDeath	date	Nullable
Remarks	Remarks	string	-
Photo	Photo	Collection of byte	-
PhotoMimeType	Mime type of the Photo image	string	-
MaritalStatus	MaritalStatus	string	-
LegalStatus	LegalStatus	string	-
ParticularFormOfCommunication	ParticularFormOfCommunication	string	-
LivingUnit	LivingUnit	string	-
NationalityId	NationalityId	integer	Nullable
Nationality	Nationality	string	-
LanguageId	LanguageId	integer	Nullable
Language	Language	string	-
ReligionId	ReligionId	integer	Nullable
Religion	Religion	string	-
ClientId	Contains the id of the client.	integer	-
MigrationIdentifier	Contains the id of the client which used in PlanCare Dossier, also known as 'BewonerId'.	integer	Nullable
NameUsage	Rule for formatting the LastName	NameUsage	-
RegistrationNumber	Registration number	string	-
SecretPlacement	SecretPlacement	boolean	-
DebtorNumber	DebtorNumber	string	-
Iban	Iban	string	-
BankAccountBic	BankAccountBic	string	-
BankAccountHolderName	BankAccountHolderName	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "RelationId": 1,
    "SocialSecurityNumber": "sample string 2",
    "SocialSecurityNumberVerified": true,
    "SocialSecurityNumberVerificationInfo": "sample string 4",
    "FirstName": "sample string 5",
    "Initials": "sample string 6",
    "NickName": "sample string 7",
    "BirthName": "sample string 8",
    "BirthNamePrefix": "sample string 9",
    "PartnerName": "sample string 10",
    "PartnerNamePrefix": "sample string 11",
    "LookupName": "sample string 12",
    "LastName": "sample string 13",
    "Gender": "sample string 14",
    "DateOfBirth": "2026-05-26T21:12:20.8629411+02:00",
    "DateOfBirthCompleteness": 0,
    "CityOfBirth": "sample string 15",
    "CountryOfBirthId": 1,
    "DateOfDeath": "2026-05-26T21:12:20.8629411+02:00",
    "Remarks": "sample string 16",
    "Photo": "QEA=",
    "PhotoMimeType": "sample string 17",
    "MaritalStatus": "sample string 18",
    "LegalStatus": "sample string 19",
    "ParticularFormOfCommunication": "sample string 20",
    "LivingUnit": "sample string 21",
    "NationalityId": 1,
    "Nationality": "sample string 22",
    "LanguageId": 1,
    "Language": "sample string 23",
    "ReligionId": 1,
    "Religion": "sample string 24",
    "ClientId": 25,
    "MigrationIdentifier": 1,
    "NameUsage": 0,
    "RegistrationNumber": "sample string 26",
    "SecretPlacement": true,
    "DebtorNumber": "sample string 28",
    "Iban": "sample string 29",
    "BankAccountBic": "sample string 30",
    "BankAccountHolderName": "sample string 31"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Client">
  <Client>
    <BankAccountBic>sample string 30</BankAccountBic>
    <BankAccountHolderName>sample string 31</BankAccountHolderName>
    <BirthName>sample string 8</BirthName>
    <BirthNamePrefix>sample string 9</BirthNamePrefix>
    <CityOfBirth>sample string 15</CityOfBirth>
    <ClientId>25</ClientId>
    <CountryOfBirthId>1</CountryOfBirthId>
    <DateOfBirth>2026-05-26T21:12:20.8629411+02:00</DateOfBirth>
    <DateOfBirthCompleteness>Complete</DateOfBirthCompleteness>
    <DateOfDeath>2026-05-26T21:12:20.8629411+02:00</DateOfDeath>
    <DebtorNumber>sample string 28</DebtorNumber>
    <FirstName>sample string 5</FirstName>
    <Gender>sample string 14</Gender>
    <Iban>sample string 29</Iban>
    <Initials>sample string 6</Initials>
    <Language>sample string 23</Language>
    <LanguageId>1</LanguageId>
    <LastName>sample string 13</LastName>
    <LegalStatus>sample string 19</LegalStatus>
    <LivingUnit>sample string 21</LivingUnit>
    <LookupName>sample string 12</LookupName>
    <MaritalStatus>sample string 18</MaritalStatus>
    <MigrationIdentifier>1</MigrationIdentifier>
    <NameUsage>Custom</NameUsage>
    <Nationality>sample string 22</Nationality>
    <NationalityId>1</NationalityId>
    <NickName>sample string 7</NickName>
    <ParticularFormOfCommunication>sample string 20</ParticularFormOfCommunication>
    <PartnerName>sample string 10</PartnerName>
    <PartnerNamePrefix>sample string 11</PartnerNamePrefix>
    <Photo>QEA=</Photo>
    <PhotoMimeType>sample string 17</PhotoMimeType>
    <RegistrationNumber>sample string 26</RegistrationNumber>
    <RelationId>1</RelationId>
    <Religion>sample string 24</Religion>
    <ReligionId>1</ReligionId>
    <Remarks>sample string 16</Remarks>
    <SecretPlacement>true</SecretPlacement>
    <SocialSecurityNumber>sample string 2</SocialSecurityNumber>
    <SocialSecurityNumberVerificationInfo>sample string 4</SocialSecurityNumberVerificationInfo>
    <SocialSecurityNumberVerified>true</SocialSecurityNumberVerified>
  </Client>
  <Client>
    <BankAccountBic>sample string 30</BankAccountBic>
    <BankAccountHolderName>sample string 31</BankAccountHolderName>
    <BirthName>sample string 8</BirthName>
    <BirthNamePrefix>sample string 9</BirthNamePrefix>
    <CityOfBirth>sample string 15</CityOfBirth>
    <ClientId>25</ClientId>
    <CountryOfBirthId>1</CountryOfBirthId>
    <DateOfBirth>2026-05-26T21:12:20.8629411+02:00</DateOfBirth>
    <DateOfBirthCompleteness>Complete</DateOfBirthCompleteness>
    <DateOfDeath>2026-05-26T21:12:20.8629411+02:00</DateOfDeath>
    <DebtorNumber>sample string 28</DebtorNumber>
    <FirstName>sample string 5</FirstName>
    <Gender>sample string 14</Gender>
    <Iban>sample string 29</Iban>
    <Initials>sample string 6</Initials>
    <Language>sample string 23</Language>
    <LanguageId>1</LanguageId>
    <LastName>sample string 13</LastName>
    <LegalStatus>sample string 19</LegalStatus>
    <LivingUnit>sample string 21</LivingUnit>
    <LookupName>sample string 12</LookupName>
    <MaritalStatus>sample string 18</MaritalStatus>
    <MigrationIdentifier>1</MigrationIdentifier>
    <NameUsage>Custom</NameUsage>
    <Nationality>sample string 22</Nationality>
    <NationalityId>1</NationalityId>
    <NickName>sample string 7</NickName>
    <ParticularFormOfCommunication>sample string 20</ParticularFormOfCommunication>
    <PartnerName>sample string 10</PartnerName>
    <PartnerNamePrefix>sample string 11</PartnerNamePrefix>
    <Photo>QEA=</Photo>
    <PhotoMimeType>sample string 17</PhotoMimeType>
    <RegistrationNumber>sample string 26</RegistrationNumber>
    <RelationId>1</RelationId>
    <Religion>sample string 24</Religion>
    <ReligionId>1</ReligionId>
    <Remarks>sample string 16</Remarks>
    <SecretPlacement>true</SecretPlacement>
    <SocialSecurityNumber>sample string 2</SocialSecurityNumber>
    <SocialSecurityNumberVerificationInfo>sample string 4</SocialSecurityNumberVerificationInfo>
    <SocialSecurityNumberVerified>true</SocialSecurityNumberVerified>
  </Client>
</ArrayOfClient>